Document runtime markdown loading: when recompilation is required vs optional#12754
Merged
Document runtime markdown loading: when recompilation is required vs optional#12754
Conversation
- Created new guide: guides/editing-workflows.md - Explains when markdown body can be edited without recompilation - Explains when frontmatter changes require recompilation - Added practical examples and quick reference table - Updated workflow-structure.md to reference new guide - Updated markdown.md with editing tips - Added FAQ entry about editing on GitHub.com - Updated compilation-process.md with tip about runtime loading - All documentation builds successfully with no errors Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation on editing markdown body
Document runtime markdown loading: when recompilation is required vs optional
Jan 30, 2026
pelikhan
reviewed
Jan 30, 2026
| order: 5 | ||
| --- | ||
|
|
||
| Agentic workflows consist of two distinct parts with different editing requirements: the **YAML frontmatter** (configuration) and the **markdown body** (AI instructions). Understanding when changes require recompilation helps you iterate quickly and efficiently. |
| Workflow files (`.md`) are compiled into GitHub Actions workflow files (`.lock.yml`). The compilation process: | ||
|
|
||
| - **Embeds frontmatter** directly into the lock file (changes require recompilation) | ||
| - **References the markdown body** at runtime via `{{#runtime-import}}` macro (changes do NOT require recompilation) |
Comment on lines
112
to
132
| ### Recompilation Workflow | ||
|
|
||
| ```bash | ||
| # 1. Clone repository locally | ||
| git clone https://github.com/your-org/your-repo.git | ||
| cd your-repo | ||
|
|
||
| # 2. Edit the frontmatter in .github/workflows/my-workflow.md | ||
| vim .github/workflows/my-workflow.md | ||
|
|
||
| # 3. Recompile the workflow | ||
| gh aw compile my-workflow | ||
|
|
||
| # 4. Review changes | ||
| git diff .github/workflows/my-workflow.lock.yml | ||
|
|
||
| # 5. Commit and push | ||
| git add .github/workflows/my-workflow.md .github/workflows/my-workflow.lock.yml | ||
| git commit -m "Update workflow configuration" | ||
| git push origin main | ||
| ``` |
Contributor
Author
There was a problem hiding this comment.
Removed the Recompilation Workflow section in commit 9fd290e.
|
|
||
| Use `needs.activation.outputs.text` for sanitized user input instead. | ||
|
|
||
| ## Best Practices |
Contributor
Author
There was a problem hiding this comment.
Removed the Best Practices section in commit 9fd290e.
| - Auditability: Changes to compiled workflows are visible in git history | ||
| - Reproducibility: Anyone can see the exact configuration | ||
|
|
||
| ## Troubleshooting |
Contributor
Author
There was a problem hiding this comment.
Removed the Troubleshooting section in commit 9fd290e.
- Added reference to Authoring Workflows with AI guide - Removed internal implementation details (runtime-import macro) - Removed Recompilation Workflow section (redundant) - Removed Best Practices section (covered elsewhere) - Removed Troubleshooting section (belongs in troubleshooting docs) - Documentation builds successfully Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Plan: Update Documentation with Editing Tips
{{#runtime-import}}macromake build-docsto ensure no errorsOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.